安全提供程序(SecurityProviderV)

[GET] /api/v2/identity/security-providers

获取所有安全提供程序。

参数

名称	类型	位置	描述
available	Boolean	query	是否只获取所有可用的安全提供程序。

响应

状态代码: 200

成功

SecurityProviderModel

[PUT] /api/v2/identity/security-providers/{name}

更新指定的安全提供程序的设置。

参数

名称	类型	位置	描述
name必填项	string	path	安全提供程序名称

请求数据格式

SecurityProviderModel

响应

状态代码: 200

成功

SecurityProviderModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/security-providers/{name}

删除指定的安全提供程序。

参数

名称	类型	位置	描述
name必填项	string	path

响应

状态代码: 204

成功

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/security-providers/enable

启用或禁用指定的安全提供程序。

请求数据格式

SecurityProviderEnableModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[POST] /api/v2/identity/security-providers/move

更新指定安全提供程序的序号。

请求数据格式

SecurityProviderMoveModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/security-providers/reload

重新加载所有安全提供程序。

响应

状态代码: 200

成功

SecurityProviderModel

[GET] /api/v2/identity/security-providers/export

导出安全提供程序。

响应

状态代码: 200

成功

SecurityProviderModel

[POST] /api/v2/identity/security-providers/import

导入安全提供程序。

请求数据格式

SecurityProvidersImportModel

响应

状态代码: 200

成功

SecurityProviderModel

状态代码: 400

错误请求

ApiErrorResult

模型定义

Ƭ SecurityProviderModel

名称	类型	描述	示例
providerName可为空	string	安全提供程序名称。	"AD Security Provider"
description可为空	string	安全提供程序描述文本。	"The built-in AD security provider."
ordinal	int32	安全提供程序序号。	1
enabled	Boolean	是否启用了安全提供程序。	true
settings可为空	ConfigurationItem	配置项。

Ƭ ConfigurationItem

名称	类型	描述	示例
name可为空	string
displayName可为空	string
description可为空	string
valueType	ConfigurationItemValueType
value可为空	any
restriction	ConfigurationItemRestriction

Ƭ ConfigurationItemValueType

Enum:

• Text
• Boolean
• Number
• Password

配置项的值类型。

* Text - 0 - 一个普通字符串。
* Boolean - 1 - 一个布尔值。
* Number - 2 - 一个数字。
* Password - 3 - 用作密码的字符串。

Ƭ ConfigurationItemRestriction

Enum:

• Mandatory
• Optional

配置项的限制。

* Mandatory - 0 - 表示这个配置项是必填的。
* Optional - 1 - 表示这个配置项是可选的。

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称	类型	描述	示例
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ SecurityProviderEnableModel

名称	类型	描述	示例
providerNames	Array<string>	提供程序名称。	["AD Security Provider","LDAP Security Provider"]
enable	Boolean	True 表示启用，false 表示禁用。	true

Ƭ SecurityProviderMoveModel

名称	类型	描述	示例
providerName	string	安全提供程序的名称。	"AD Security Provider"
offset	int32	安全提供程序当前订单的偏移量, 负数表示向上移动，正数表示向下移动。	-1

Ƭ SecurityProvidersImportModel

名称	类型	描述	示例
securityProviders	SecurityProviderModel	安全提供程序列表。